LabelImage Property, SftTreeItem Object


	SftTreeItem.LabelImage Property	Softel vdm, Inc.

Defines the label graphic displayed in this item.

Syntax

Get
	VB.NET	refImageObj = object.LabelImage As SftPictureObject
	VB	Set refImageObj = object.LabelImage As SftPictureObject
	C#.NET	SftPictureObject refImageObj = object.LabelImage;
	VC++	ISftPictureObject* refImageObj = object->LabelImage; ISftPictureObject* refImageObj = object->GetLabelImage();
	C	HRESULT object->get_LabelImage(ISftPictureObject** refImageObj);
	Delphi	refImageObj := object.LabelImage : ISftPictureObject;
Put
	VB.NET	object.LabelImage = refImageObj As SftPictureObject
	VB	object.LabelImage = refImageObj As SftPictureObject
	C#.NET	SftPictureObject object.LabelImage = refImageObj;
	VC++	ISftPictureObject* object->LabelImage = refImageObj; void object->PutLabelImage(ISftPictureObject* refImageObj);
	C	HRESULT object->put_LabelImage(ISftPictureObject* refImageObj);
	Delphi	object.LabelImage := refImageObj : ISftPictureObject;

object

A SftTreeItem object.

refImageObj

Defines the label graphic displayed in this item.

Comments

The LabelImage property defines the label graphic displayed in this item.

When using fixed height items (see Items.Style), all graphics used in a tree control as LabelImage property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as LabelImage property are never clipped vertically. To change the label graphic size, all label graphics must be removed first using the Items.ClearLabelImages method.

When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.

If the image object refImageObj defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see Bitmap Transparency).

The Items.ClearLabelImages method can be used to remove all label graphics. The LabelImage property can be set to the value Nothing (NULL), which removes the graphic from the item.

The VAlignStyle property can be used to define the vertical alignment of label graphics.